<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>QueryBuilder, yii\sphinx\QueryBuilder - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w12013" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w12013-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w12013-collapse" class="collapse navbar-collapse"><ul id="w12014" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w12015" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-12011" data-toggle="collapse" data-parent="#navigation">yii\sphinx <b class="caret"></b></a><div id="navigation-12011" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii-sphinx-activedataprovider.html">ActiveDataProvider</a>
<a class="list-group-item" href="./yii-sphinx-activefixture.html">ActiveFixture</a>
<a class="list-group-item" href="./yii-sphinx-activequery.html">ActiveQuery</a>
<a class="list-group-item" href="./yii-sphinx-activerecord.html">ActiveRecord</a>
<a class="list-group-item" href="./yii-sphinx-columnschema.html">ColumnSchema</a>
<a class="list-group-item" href="./yii-sphinx-command.html">Command</a>
<a class="list-group-item" href="./yii-sphinx-connection.html">Connection</a>
<a class="list-group-item" href="./yii-sphinx-indexschema.html">IndexSchema</a>
<a class="list-group-item" href="./yii-sphinx-query.html">Query</a>
<a class="list-group-item active" href="./yii-sphinx-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-sphinx-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-12012" data-toggle="collapse" data-parent="#navigation">yii\sphinx\gii\model <b class="caret"></b></a><div id="navigation-12012" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-sphinx-gii-model-generator.html">Generator</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\sphinx\QueryBuilder</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
                    | <a href="#constants">Constants</a>
    </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a></td></tr>
                                    <tr><th>Available since version</th><td>2.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php">https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>QueryBuilder builds a SELECT SQL statement based on the specification given as a <a href="yii-sphinx-query.html">yii\sphinx\Query</a> object.</strong></p>
    <p>QueryBuilder can also be used to build SQL statements such as INSERT, REPLACE, UPDATE, DELETE,
from a <a href="yii-sphinx-query.html">yii\sphinx\Query</a> object.</p>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
            <tr id="$db">
        <td><a href="yii-sphinx-querybuilder.html#$db-detail">$db</a></td>
        <td><a href="yii-sphinx-connection.html">yii\sphinx\Connection</a></td>
        <td>The Sphinx connection.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="$querySeparator">
        <td><a href="yii-sphinx-querybuilder.html#$querySeparator-detail">$querySeparator</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Separator between different SQL queries.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="$separator">
        <td><a href="yii-sphinx-querybuilder.html#$separator-detail">$separator</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The separator between different fragments of a SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-property">
<h2>Protected Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr id="$conditionBuilders">
        <td><a href="yii-sphinx-querybuilder.html#$conditionBuilders-detail">$conditionBuilders</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Map of query condition to builder methods.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-object.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="__construct()">
        <td><a href="yii-sphinx-querybuilder.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-object.html#__get()-detail">__get()</a></td>
        <td>Returns the value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-object.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-object.html#__set()-detail">__set()</a></td>
        <td>Sets value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-object.html#__unset()-detail">__unset()</a></td>
        <td>Sets an object property to null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="batchInsert()">
        <td><a href="yii-sphinx-querybuilder.html#batchInsert()-detail">batchInsert()</a></td>
        <td>Generates a batch INSERT SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="batchReplace()">
        <td><a href="yii-sphinx-querybuilder.html#batchReplace()-detail">batchReplace()</a></td>
        <td>Generates a batch REPLACE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="build()">
        <td><a href="yii-sphinx-querybuilder.html#build()-detail">build()</a></td>
        <td>Generates a SELECT SQL statement from a <a href="yii-sphinx-query.html">yii\sphinx\Query</a> object.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildAndCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildAndCondition()-detail">buildAndCondition()</a></td>
        <td>Connects two or more SQL expressions with the <code>AND</code> or <code>OR</code> operator.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildBetweenCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildBetweenCondition()-detail">buildBetweenCondition()</a></td>
        <td>Creates an SQL expressions with the <code>BETWEEN</code> operator.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildColumns()">
        <td><a href="yii-sphinx-querybuilder.html#buildColumns()-detail">buildColumns()</a></td>
        <td>Processes columns and properly quote them if necessary.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                <tr id="buildCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildCondition()-detail">buildCondition()</a></td>
        <td>Parses the condition specification and generates the corresponding SQL expression.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                <tr id="buildFrom()">
        <td><a href="yii-sphinx-querybuilder.html#buildFrom()-detail">buildFrom()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildGroupBy()">
        <td><a href="yii-sphinx-querybuilder.html#buildGroupBy()-detail">buildGroupBy()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildHashCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildHashCondition()-detail">buildHashCondition()</a></td>
        <td>Creates a condition based on column-value pairs.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildHaving()">
        <td><a href="yii-sphinx-querybuilder.html#buildHaving()-detail">buildHaving()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildInCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildInCondition()-detail">buildInCondition()</a></td>
        <td>Creates an SQL expressions with the <code>IN</code> operator.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildLikeCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildLikeCondition()-detail">buildLikeCondition()</a></td>
        <td>Creates an SQL expressions with the <code>LIKE</code> operator.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildLimit()">
        <td><a href="yii-sphinx-querybuilder.html#buildLimit()-detail">buildLimit()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildNotCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildNotCondition()-detail">buildNotCondition()</a></td>
        <td>Inverts an SQL expressions with <code>NOT</code> operator.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildOption()">
        <td><a href="yii-sphinx-querybuilder.html#buildOption()-detail">buildOption()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildOrderBy()">
        <td><a href="yii-sphinx-querybuilder.html#buildOrderBy()-detail">buildOrderBy()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildOrderByAndLimit()">
        <td><a href="yii-sphinx-querybuilder.html#buildOrderByAndLimit()-detail">buildOrderByAndLimit()</a></td>
        <td>Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildSelect()">
        <td><a href="yii-sphinx-querybuilder.html#buildSelect()-detail">buildSelect()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                <tr id="buildSimpleCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildSimpleCondition()-detail">buildSimpleCondition()</a></td>
        <td>Creates an SQL expressions like <code>"column" operator value</code>.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildWhere()">
        <td><a href="yii-sphinx-querybuilder.html#buildWhere()-detail">buildWhere()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="buildWithin()">
        <td><a href="yii-sphinx-querybuilder.html#buildWithin()-detail">buildWithin()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="callKeywords()">
        <td><a href="yii-sphinx-querybuilder.html#callKeywords()-detail">callKeywords()</a></td>
        <td>Builds a SQL statement for returning tokenized and normalized forms of the keywords, and,
optionally, keyword statistics.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="callSnippets()">
        <td><a href="yii-sphinx-querybuilder.html#callSnippets()-detail">callSnippets()</a></td>
        <td>Builds a SQL statement for call snippet from provided data and query, using specified index settings.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-object.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-object.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
                <tr id="delete()">
        <td><a href="yii-sphinx-querybuilder.html#delete()-detail">delete()</a></td>
        <td>Creates a DELETE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                    <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-object.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-object.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="init()">
        <td><a href="yii-base-object.html#init()-detail">init()</a></td>
        <td>Initializes the object.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="insert()">
        <td><a href="yii-sphinx-querybuilder.html#insert()-detail">insert()</a></td>
        <td>Creates an INSERT SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="replace()">
        <td><a href="yii-sphinx-querybuilder.html#replace()-detail">replace()</a></td>
        <td>Creates an REPLACE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="truncateIndex()">
        <td><a href="yii-sphinx-querybuilder.html#truncateIndex()-detail">truncateIndex()</a></td>
        <td>Builds a SQL statement for truncating an index.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="update()">
        <td><a href="yii-sphinx-querybuilder.html#update()-detail">update()</a></td>
        <td>Creates an UPDATE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                        <tr id="buildCompositeInCondition()">
        <td><a href="yii-sphinx-querybuilder.html#buildCompositeInCondition()-detail">buildCompositeInCondition()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                <tr id="buildFacets()">
        <td><a href="yii-sphinx-querybuilder.html#buildFacets()-detail">buildFacets()</a></td>
        <td></td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                                                            <tr id="buildShowMeta()">
        <td><a href="yii-sphinx-querybuilder.html#buildShowMeta()-detail">buildShowMeta()</a></td>
        <td>Builds SHOW META query.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                                            <tr id="composeColumnValue()">
        <td><a href="yii-sphinx-querybuilder.html#composeColumnValue()-detail">composeColumnValue()</a></td>
        <td>Composes column value for SQL, taking in account the column type.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                <tr id="generateBatchInsertReplace()">
        <td><a href="yii-sphinx-querybuilder.html#generateBatchInsertReplace()-detail">generateBatchInsertReplace()</a></td>
        <td>Generates a batch INSERT/REPLACE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
            <tr id="generateInsertReplace()">
        <td><a href="yii-sphinx-querybuilder.html#generateInsertReplace()-detail">generateInsertReplace()</a></td>
        <td>Generates INSERT/REPLACE SQL statement.</td>
        <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
    </tr>
                                </table>
</div>

<a id="events"></a>

<a id="constants"></a>
<div class="summary doc-const">
    <h2>Constants</h2>

    <p><a href="#" class="toggle">Hide inherited constants</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-const" />
        <col class="col-value" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Constant</th><th>Value</th><th>Description</th><th>Defined By</th>
    </tr>
            <tr id="PARAM_PREFIX">
          <td id="PARAM_PREFIX-detail">PARAM_PREFIX</td>
          <td>':qp'</td>
          <td>The prefix for automatically generated query binding parameters.
</td>
          <td><a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a></td>
        </tr>
        </table>
</div>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$conditionBuilders-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#$conditionBuilders-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L52" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L52" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $conditionBuilders        <span class="detail-header-tag small">
            protected                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Map of query condition to builder methods.
These methods are used by <a href="yii-sphinx-querybuilder.html#buildCondition()-detail">buildCondition()</a> to build SQL conditions from array syntax.</p>

            </div>

    <div class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-sphinx-querybuilder.html#$conditionBuilders-detail">$conditionBuilders</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;[</span><span style="color: #DD0000">'AND'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildAndCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'OR'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildAndCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'BETWEEN'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildBetweenCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'NOT&nbsp;BETWEEN'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildBetweenCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'IN'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildInCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'NOT&nbsp;IN'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildInCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'LIKE'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildLikeCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'NOT&nbsp;LIKE'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildLikeCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'OR&nbsp;LIKE'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildLikeCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'OR&nbsp;NOT&nbsp;LIKE'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildLikeCondition'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'NOT'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'buildNotCondition'</span><span style="color: #007700">]</span></div>


    <div class="detail-header h3" id="$db-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#$db-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L36" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L36" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $db        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The Sphinx connection.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-connection.html">yii\sphinx\Connection</a></span> <a href="yii-sphinx-querybuilder.html#$db-detail">$db</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$querySeparator-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#$querySeparator-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L46" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L46" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $querySeparator        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Separator between different SQL queries.
This is mainly used by <a href="yii-sphinx-querybuilder.html#build()-detail">build()</a> when generating a SQL statement.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-sphinx-querybuilder.html#$querySeparator-detail">$querySeparator</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">";&nbsp;"</span></div>


    <div class="detail-header h3" id="$separator-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#$separator-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L41" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L41" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $separator        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The separator between different fragments of a SQL statement.
Defaults to an empty space. This is mainly used by <a href="yii-sphinx-querybuilder.html#build()-detail">build()</a> when generating a SQL statement.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-sphinx-querybuilder.html#$separator-detail">$separator</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"&nbsp;"</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="__construct()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#__construct()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L72" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L72" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        __construct()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Constructor.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-sphinx-querybuilder.html#__construct()-detail">__construct</a></strong> ( <span style="color: #0000BB">$connection</span>, <span style="color: #0000BB">$config&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$connection</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-connection.html">yii\sphinx\Connection</a></td>
                  <td class="param-desc-col"><p>The Sphinx connection.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$config</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Name-value pairs that will be used to initialize the object properties</p>
</td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="batchInsert()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#batchInsert()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L230" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L230" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        batchInsert()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates a batch INSERT SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;batchInsert(<span class="hljs-string">'idx_user'</span>, [<span class="hljs-string">'id'</span>, <span class="hljs-string">'name'</span>, <span class="hljs-string">'age'</span>], [
    [<span class="hljs-number">1</span>, <span class="hljs-string">'Tom'</span>, <span class="hljs-number">30</span>],
    [<span class="hljs-number">2</span>, <span class="hljs-string">'Jane'</span>, <span class="hljs-number">20</span>],
    [<span class="hljs-number">3</span>, <span class="hljs-string">'Linda'</span>, <span class="hljs-number">25</span>],
], <span class="hljs-variable">$params</span>);
</code></pre>
<p>Note that the values in each row must match the corresponding column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#batchInsert()-detail">batchInsert</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$rows</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be inserted into.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column names</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The rows to be batch inserted into the index</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.
They should be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The batch INSERT SQL statement</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="batchReplace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#batchReplace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L256" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L256" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        batchReplace()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates a batch REPLACE SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;batchReplace(<span class="hljs-string">'idx_user'</span>, [<span class="hljs-string">'id'</span>, <span class="hljs-string">'name'</span>, <span class="hljs-string">'age'</span>], [
    [<span class="hljs-number">1</span>, <span class="hljs-string">'Tom'</span>, <span class="hljs-number">30</span>],
    [<span class="hljs-number">2</span>, <span class="hljs-string">'Jane'</span>, <span class="hljs-number">20</span>],
    [<span class="hljs-number">3</span>, <span class="hljs-string">'Linda'</span>, <span class="hljs-number">25</span>],
], <span class="hljs-variable">$params</span>);
</code></pre>
<p>Note that the values in each row must match the corresponding column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#batchReplace()-detail">batchReplace</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$rows</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be replaced.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column names</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The rows to be batch replaced in the index</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.
They should be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The batch INSERT SQL statement</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="build()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#build()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L88" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L88" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        build()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates a SELECT SQL statement from a <a href="yii-sphinx-query.html">yii\sphinx\Query</a> object.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-sphinx-querybuilder.html#build()-detail">build</a></strong> ( <span style="color: #0000BB">$query</span>, <span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$query</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-query.html">yii\sphinx\Query</a></td>
                  <td class="param-desc-col"><p>The <a href="yii-sphinx-query.html">yii\sphinx\Query</a> object from which the SQL statement will be generated</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters to be bound to the generated SQL statement. These parameters will
be included in the result with the additional parameters generated during the query building process.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The generated SQL statement (the first array element) and the corresponding
parameters to be bound to the SQL statement (the second array element). The parameters returned
include those provided in <code>$params</code>.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-notsupportedexception.html">yii\base\NotSupportedException</a></td>
                  <td class="param-desc-col"><p>if query contains 'join' option.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildAndCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildAndCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L762" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L762" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildAndCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Connects two or more SQL expressions with the <code>AND</code> or <code>OR</code> operator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildAndCondition()-detail">buildAndCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use for connecting the given operands</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The SQL expressions to connect.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildBetweenCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildBetweenCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L816" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L816" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildBetweenCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an SQL expressions with the <code>BETWEEN</code> operator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildBetweenCondition()-detail">buildBetweenCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use (e.g. <code>BETWEEN</code> or <code>NOT BETWEEN</code>)</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The first operand is the column name. The second and third operands
describe the interval that column value should be in.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-db-exception.html">yii\db\Exception</a></td>
                  <td class="param-desc-col"><p>if wrong number of operands have been given.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildColumns()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildColumns()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L671" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L671" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildColumns()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Processes columns and properly quote them if necessary.</strong></p>

        <p>It will join all columns into a string with comma as separators.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildColumns()-detail">buildColumns</a></strong> ( <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The columns to be processed</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The processing result</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildCompositeInCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildCompositeInCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L924" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L924" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildCompositeInCondition()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildCompositeInCondition()-detail">buildCompositeInCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$values</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use (e.g. <code>IN</code> or <code>NOT IN</code>)</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$values</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L700" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L700" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Parses the condition specification and generates the corresponding SQL expression.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildCondition()-detail">buildCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The condition specification. Please refer to <a href="yii-db-querytrait.html#where()-detail">yii\sphinx\Query::where()</a>
on how to specify a condition.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-db-exception.html">yii\db\Exception</a></td>
                  <td class="param-desc-col"><p>if the condition is in bad format</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildFacets()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildFacets()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1121" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1121" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildFacets()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildFacets()-detail">buildFacets</a></strong> ( <span style="color: #0000BB">$facets</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$facets</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Facet specifications</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The FACET clause build from <span class="broken-link">\yii\sphinx\query</span></p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidconfigexception.html">yii\base\InvalidConfigException</a></td>
                  <td class="param-desc-col"><p>on invalid facet specification.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildFrom()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildFrom()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L510" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L510" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildFrom()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildFrom()-detail">buildFrom</a></strong> ( <span style="color: #0000BB">$indexes</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The FROM clause built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildGroupBy()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildGroupBy()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L580" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L580" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildGroupBy()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildGroupBy()-detail">buildGroupBy</a></strong> ( <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The GROUP BY clause</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildHashCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildHashCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L730" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L730" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildHashCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a condition based on column-value pairs.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildHashCondition()-detail">buildHashCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The condition specification.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildHaving()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildHaving()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L591" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L591" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildHaving()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildHaving()-detail">buildHaving</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>[]</td>
                  <td class="param-desc-col"><p>List of index names, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The HAVING clause built from <a href="yii-db-query.html#$having-detail">yii\sphinx\Query::$having</a>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildInCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildInCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L848" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L848" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildInCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an SQL expressions with the <code>IN</code> operator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildInCondition()-detail">buildInCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use (e.g. <code>IN</code> or <code>NOT IN</code>)</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The first operand is the column name. If it is an array
a composite IN condition will be generated.
The second operand is an array of values that column value should be among.
If it is an empty array the generated expression will be a <code>false</code> value if
operator is <code>IN</code> and empty if operator is <code>NOT IN</code>.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-db-exception.html">yii\db\Exception</a></td>
                  <td class="param-desc-col"><p>if wrong number of operands have been given.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildLikeCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildLikeCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L968" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L968" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildLikeCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an SQL expressions with the <code>LIKE</code> operator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildLikeCondition()-detail">buildLikeCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use (e.g. <code>LIKE</code>, <code>NOT LIKE</code>, <code>OR LIKE</code> or <code>OR NOT LIKE</code>)</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>An array of two or three operands</p>
<ul>
<li>The first operand is the column name.</li>
<li>The second operand is a single value or an array of values that column value
should be compared with. If it is an empty array the generated expression will
be a <code>false</code> value if operator is <code>LIKE</code> or <code>OR LIKE</code>, and empty if operator
is <code>NOT LIKE</code> or <code>OR NOT LIKE</code>.</li>
<li>An optional third operand can also be provided to specify how to escape special characters
in the value(s). The operand should be an array of mappings from the special characters to their
escaped counterparts. If this operand is not provided, a default escape mapping will be used.
You may use <code>false</code> or an empty array to indicate the values are already escaped and no escape
should be applied. Note that when using an escape mapping (or the third operand is not provided),
the values will be automatically enclosed within a pair of percentage characters.</li>
</ul>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidparamexception.html">yii\base\InvalidParamException</a></td>
                  <td class="param-desc-col"><p>if wrong number of operands have been given.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildLimit()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildLimit()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L650" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L650" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildLimit()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildLimit()-detail">buildLimit</a></strong> ( <span style="color: #0000BB">$limit</span>, <span style="color: #0000BB">$offset</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$limit</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$offset</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The LIMIT and OFFSET clauses built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildNotCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildNotCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L789" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L789" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildNotCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Inverts an SQL expressions with <code>NOT</code> operator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildNotCondition()-detail">buildNotCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use for connecting the given operands</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The SQL expressions to connect.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidparamexception.html">yii\base\InvalidParamException</a></td>
                  <td class="param-desc-col"><p>if wrong number of operands have been given.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildOption()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildOption()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1076" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1076" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildOption()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildOption()-detail">buildOption</a></strong> ( <span style="color: #0000BB">$options</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Query options in format: optionName =&gt; optionValue</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The OPTION clause build from <span class="broken-link">\yii\sphinx\query</span></p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildOrderBy()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildOrderBy()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L628" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L628" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildOrderBy()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildOrderBy()-detail">buildOrderBy</a></strong> ( <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The ORDER BY clause built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildOrderByAndLimit()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildOrderByAndLimit()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L611" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L611" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildOrderByAndLimit()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildOrderByAndLimit()-detail">buildOrderByAndLimit</a></strong> ( <span style="color: #0000BB">$sql</span>, <span style="color: #0000BB">$orderBy</span>, <span style="color: #0000BB">$limit</span>, <span style="color: #0000BB">$offset</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$sql</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The existing SQL (without ORDER BY/LIMIT/OFFSET)</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$orderBy</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The order by columns. See <a href="yii-db-querytrait.html#orderBy()-detail">yii\sphinx\Query::orderBy()</a> for more details on how to specify this parameter.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$limit</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>The limit number. See <a href="yii-db-querytrait.html#limit()-detail">yii\sphinx\Query::limit()</a> for more details.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$offset</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>The offset number. See <a href="yii-db-querytrait.html#offset()-detail">yii\sphinx\Query::offset()</a> for more details.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The SQL completed with ORDER BY/LIMIT/OFFSET (if any)</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildSelect()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildSelect()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L466" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L466" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildSelect()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildSelect()-detail">buildSelect</a></strong> ( <span style="color: #0000BB">$columns</span>, <b>&</b><span style="color: #0000BB">$params</span>, <span style="color: #0000BB">$distinct&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span>, <span style="color: #0000BB">$selectOption&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$distinct</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$selectOption</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The SELECT clause built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildShowMeta()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildShowMeta()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1169" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1169" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildShowMeta()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds SHOW META query.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildShowMeta()-detail">buildShowMeta</a></strong> ( <span style="color: #0000BB">$showMeta</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$showMeta</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a>|<a href="http://www.php.net/language.types.string">string</a>|<a href="yii-db-expression.html">yii\db\Expression</a></td>
                  <td class="param-desc-col"><p>Show meta specification.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>SHOW META query, if it does not required - empty string.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildSimpleCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildSimpleCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1024" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1024" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildSimpleCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an SQL expressions like <code>"column" operator value</code>.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildSimpleCondition()-detail">buildSimpleCondition</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$operator</span>, <span style="color: #0000BB">$operands</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operator</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The operator to use. Anything could be used e.g. <code>&gt;</code>, <code>&lt;=</code>, etc.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$operands</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Contains two column names.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The generated SQL expression</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidparamexception.html">yii\base\InvalidParamException</a></td>
                  <td class="param-desc-col"><p>if count($operands) is not 2</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="buildWhere()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildWhere()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L548" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L548" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildWhere()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildWhere()-detail">buildWhere</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span>, <span style="color: #0000BB">$match&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>[]</td>
                  <td class="param-desc-col"><p>List of index names, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$match</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="yii-db-expression.html">yii\db\Expression</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The WHERE clause built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="buildWithin()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#buildWithin()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1054" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1054" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        buildWithin()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#buildWithin()-detail">buildWithin</a></strong> ( <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The ORDER BY clause built from <span class="broken-link">\yii\sphinx\query</span>.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="callKeywords()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#callKeywords()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L449" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L449" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        callKeywords()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds a SQL statement for returning tokenized and normalized forms of the keywords, and,
optionally, keyword statistics.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#callKeywords()-detail">callKeywords</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$text</span>, <span style="color: #0000BB">$fetchStatistic</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the index from which to take the text processing settings</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$text</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The text to break down to keywords.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$fetchStatistic</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether to return document and hit occurrence statistics</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be modified by this method
so that they can be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The SQL statement for call keywords.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="callSnippets()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#callSnippets()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L393" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L393" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        callSnippets()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds a SQL statement for call snippet from provided data and query, using specified index settings.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#callSnippets()-detail">callSnippets</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$source</span>, <span style="color: #0000BB">$match</span>, <span style="color: #0000BB">$options</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Name of the index, from which to take the text processing settings.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$source</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Is the source data to extract a snippet from.
It could be either a single string or array of strings.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$match</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The full-text query to build snippets for.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>List of options in format: optionName =&gt; optionValue</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be modified by this method
so that they can be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The SQL statement for call snippets.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="composeColumnValue()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#composeColumnValue()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L1202" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L1202" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        composeColumnValue()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Composes column value for SQL, taking in account the column type.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#composeColumnValue()-detail">composeColumnValue</a></strong> ( <span style="color: #0000BB">$indexes</span>, <span style="color: #0000BB">$columnName</span>, <span style="color: #0000BB">$value</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$indexes</span></td>
                  <td class="param-type-col"><a href="yii-sphinx-indexschema.html">yii\sphinx\IndexSchema</a>[]</td>
                  <td class="param-desc-col"><p>List of indexes, which affected by query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columnName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Name of the column</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$value</span></td>
                  <td class="param-type-col">mixed</td>
                  <td class="param-desc-col"><p>Raw column value</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters to be populated</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>SQL expression, which represents column value</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="delete()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#delete()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L364" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L364" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        delete()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a DELETE SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;delete(<span class="hljs-string">'idx_user'</span>, <span class="hljs-string">'status = 0'</span>);
</code></pre>
<p>The method will properly escape the index and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#delete()-detail">delete</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index where the data will be deleted from.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The condition that will be put in the WHERE part. Please
refer to <a href="yii-db-querytrait.html#where()-detail">yii\sphinx\Query::where()</a> on how to specify condition.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be modified by this method
so that they can be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The DELETE SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="generateBatchInsertReplace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#generateBatchInsertReplace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L270" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L270" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateBatchInsertReplace()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates a batch INSERT/REPLACE SQL statement.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#generateBatchInsertReplace()-detail">generateBatchInsertReplace</a></strong> ( <span style="color: #0000BB">$statement</span>, <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$rows</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$statement</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Statement ot be generated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The affected index name.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value).</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The rows to be batch inserted into the index</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Generated SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="generateInsertReplace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#generateInsertReplace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L186" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L186" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateInsertReplace()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates INSERT/REPLACE SQL statement.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#generateInsertReplace()-detail">generateInsertReplace</a></strong> ( <span style="color: #0000BB">$statement</span>, <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$statement</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Statement ot be generated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The affected index name.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value).</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Generated SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="insert()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#insert()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L148" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L148" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        insert()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an INSERT SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;insert(<span class="hljs-string">'idx_user'</span>, [
    <span class="hljs-string">'name'</span> =&gt; <span class="hljs-string">'Sam'</span>,
    <span class="hljs-string">'age'</span> =&gt; <span class="hljs-number">30</span>,
    <span class="hljs-string">'id'</span> =&gt; <span class="hljs-number">10</span>,
], <span class="hljs-variable">$params</span>);
</code></pre>
<p>The method will properly escape the index and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#insert()-detail">insert</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be inserted into.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value) to be inserted into the index.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.
They should be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The INSERT SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="replace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#replace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L173" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L173" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        replace()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an REPLACE SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;replace(<span class="hljs-string">'idx_user'</span>, [
    <span class="hljs-string">'name'</span> =&gt; <span class="hljs-string">'Sam'</span>,
    <span class="hljs-string">'age'</span> =&gt; <span class="hljs-number">30</span>,
    <span class="hljs-string">'id'</span> =&gt; <span class="hljs-number">10</span>,
], <span class="hljs-variable">$params</span>);
</code></pre>
<p>The method will properly escape the index and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#replace()-detail">replace</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <b>&</b><span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be replaced.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value) to be replaced in the index.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be generated by this method.
They should be bound to the Sphinx command later.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The INSERT SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="truncateIndex()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#truncateIndex()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L377" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L377" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        truncateIndex()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds a SQL statement for truncating an index.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#truncateIndex()-detail">truncateIndex</a></strong> ( <span style="color: #0000BB">$index</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index to be truncated. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The SQL statement for truncating an index.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="update()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-querybuilder.html#update()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/QueryBuilder.php#L321" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/QueryBuilder.php#L321" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        update()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an UPDATE SQL statement.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$params</span> = [];
<span class="hljs-variable">$sql</span> = <span class="hljs-variable">$queryBuilder</span>-&gt;update(<span class="hljs-string">'idx_user'</span>, [<span class="hljs-string">'status'</span> =&gt; <span class="hljs-number">1</span>], <span class="hljs-string">'age &gt; 30'</span>, <span class="hljs-variable">$params</span>);
</code></pre>
<p>The method will properly escape the index and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-sphinx-querybuilder.html#update()-detail">update</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$condition</span>, <b>&</b><span style="color: #0000BB">$params</span>, <span style="color: #0000BB">$options</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index to be updated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value) to be updated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The condition that will be put in the WHERE part. Please
refer to <a href="yii-db-querytrait.html#where()-detail">yii\sphinx\Query::where()</a> on how to specify condition.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The binding parameters that will be modified by this method
so that they can be bound to the Sphinx command later.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>List of options in format: optionName =&gt; optionValue</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The UPDATE SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:57 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
